<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>ResourceKey xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../apidocs/com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
<a name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Copyright (c) 2009 Cerner Corporation.</em>
<a name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> * All rights reserved. This program and the accompanying materials</em>
<a name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * are made available under the terms of the Eclipse Public License v1.0</em>
<a name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * which accompanies this distribution, and is available at</em>
<a name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * <a href="http://www.eclipse.org/legal/epl-v10.html" target="alexandria_uri">http://www.eclipse.org/legal/epl-v10.html</a></em>
<a name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> * Contributors:</em>
<a name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> *    Cerner Corporation - initial API and implementation</em>
<a name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> */</em>
<a name="11" href="#11">11</a>  <strong class="jxr_keyword">package</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.resource.organizer.spi;
<a name="12" href="#12">12</a>  
<a name="13" href="#13">13</a>  <strong class="jxr_keyword">import</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.resource.organizer.ResourceOrganizer;
<a name="14" href="#14">14</a>  
<a name="15" href="#15">15</a>  <em class="jxr_javadoccomment">/**</em>
<a name="16" href="#16">16</a>  <em class="jxr_javadoccomment"> * Thread-safe helper class that uniquely identifies {@link ResourceOrganizer}</em>
<a name="17" href="#17">17</a>  <em class="jxr_javadoccomment"> * objects in a hierarchical tree structure.</em>
<a name="18" href="#18">18</a>  <em class="jxr_javadoccomment"> * </em>
<a name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * @author Alex Horn</em>
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> */</em>
<a name="21" href="#21">21</a>  @ThreadSafe
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a> {
<a name="23" href="#23">23</a>  
<a name="24" href="#24">24</a>    <em class="jxr_javadoccomment">/**</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment">   * Absolute URI for a node in the hierarchical tree structure. It is never</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment">   * {@code null}.</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment">   */</em>
<a name="28" href="#28">28</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> java.net.URI uri;
<a name="29" href="#29">29</a>  
<a name="30" href="#30">30</a>    <em class="jxr_javadoccomment">/**</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment">   * The number of slashes in the normalized {@link java.net.URI#getPath() URI</em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment">   * path} indicate how many parents there are. It is zero if the current key's</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment">   * URI path is the root or if the {@link #uri} is opaque.</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment">   */</em>
<a name="35" href="#35">35</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> level;
<a name="36" href="#36">36</a>  
<a name="37" href="#37">37</a>    <em class="jxr_javadoccomment">/**</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment">   * Constructor to instantiate a new {@link ResourceKey} that uniquely</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment">   * identifies {@link ResourceOrganizer} objects in a hierarchical tree. The</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment">   * URI as part of the second constructor argument will first be</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment">   * {@link java.net.URI#resolve(String) resolved} against the {@code baseURI}.</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment">   * &lt;p&gt;</em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment">   * The base URI must not be {@code null}. In addition, the base URI must</em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment">   * conform to the &lt;a</em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment">   * href="<a href="http://tools.ietf.org/html/rfc3986" target="alexandria_uri">http://tools.ietf.org/html/rfc3986</a>#section-4.3"&gt;&amp;lt;absolute-URI&amp;gt;</em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">   * syntax rule&lt;/a&gt;.</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment">   * </em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">   * @param baseURI base uniform resource identifier</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">   * @param uri uniform resource identifier for which the</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">   *          {@link ResourceOrganizer} is responsible</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">   */</em>
<a name="52" href="#52">52</a>    <strong class="jxr_keyword">public</strong> <a href="../../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a>(<strong class="jxr_keyword">final</strong> java.net.URI baseURI, <strong class="jxr_keyword">final</strong> java.net.URI uri) {
<a name="53" href="#53">53</a>      <strong class="jxr_keyword">this</strong>(baseURI.resolve(uri));
<a name="54" href="#54">54</a>    }
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>    <em class="jxr_javadoccomment">/**</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment">   * Strictly internal constructor to instantiate a new {@link ResourceKey} with</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">   * an absolute URI.</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">   * </em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">   * @param uri normalized absolute URI</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">   */</em>
<a name="62" href="#62">62</a>    <strong class="jxr_keyword">private</strong> <a href="../../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a>(<strong class="jxr_keyword">final</strong> java.net.URI uri) {
<a name="63" href="#63">63</a>      <strong class="jxr_keyword">this</strong>(uri,
<a name="64" href="#64">64</a>          countSlashes(uri.getPath() <em class="jxr_comment">/*<em class="jxr_comment"> path is never null for base URIs */</em>));</em>
<a name="65" href="#65">65</a>    }
<a name="66" href="#66">66</a>  
<a name="67" href="#67">67</a>    <em class="jxr_javadoccomment">/**</em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">   * Strictly internal constructor to instantiate a new {@link ResourceKey} with</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">   * an absolute URI and a known number of parents.</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">   * </em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">   * @param uri normalized absolute URI</em>
<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">   * @param level number of slashes in the normalized</em>
<a name="73" href="#73">73</a>  <em class="jxr_javadoccomment">   *          {@link java.net.URI#getPath() URI path}</em>
<a name="74" href="#74">74</a>  <em class="jxr_javadoccomment">   */</em>
<a name="75" href="#75">75</a>    <strong class="jxr_keyword">private</strong> <a href="../../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a>(<strong class="jxr_keyword">final</strong> java.net.URI uri, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> level) {
<a name="76" href="#76">76</a>      <em class="jxr_comment">// sanity (see parent() logic)</em>
<a name="77" href="#77">77</a>      assert level &gt;= 0;
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>      <strong class="jxr_keyword">this</strong>.uri = uri;
<a name="80" href="#80">80</a>      <strong class="jxr_keyword">this</strong>.level = level;
<a name="81" href="#81">81</a>    }
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>    <em class="jxr_javadoccomment">/**</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">   * Obtain the normalized absolute uniform resource identifier.</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">   * </em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">   * @return normalized absolute URI</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">   */</em>
<a name="88" href="#88">88</a>    <strong class="jxr_keyword">public</strong> java.net.URI uri() {
<a name="89" href="#89">89</a>      <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.uri;
<a name="90" href="#90">90</a>    }
<a name="91" href="#91">91</a>  
<a name="92" href="#92">92</a>    <em class="jxr_javadoccomment">/**</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">   * Obtain the {@link ResourceKey} that identifies the direct parent of the</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">   * current key. The return value is {@code null} if this key does not have a</em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">   * parent.</em>
<a name="96" href="#96">96</a>  <em class="jxr_javadoccomment">   * </em>
<a name="97" href="#97">97</a>  <em class="jxr_javadoccomment">   * @return parent key or {@code null} if there is none</em>
<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">   */</em>
<a name="99" href="#99">99</a>    <strong class="jxr_keyword">public</strong> <a href="../../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a> parent() {
<a name="100" href="#100">100</a>     <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.level == 0) {
<a name="101" href="#101">101</a>       <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="102" href="#102">102</a>     } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (uri().getPath().endsWith(<span class="jxr_string">"/"</span>)) {
<a name="103" href="#103">103</a>       <em class="jxr_comment">/*<em class="jxr_comment"> level &gt;= 1 */</em></em>
<a name="104" href="#104">104</a>       <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a>(uri().resolve(<span class="jxr_string">"../"</span>), <strong class="jxr_keyword">this</strong>.level - 1);
<a name="105" href="#105">105</a>     } <strong class="jxr_keyword">else</strong> {
<a name="106" href="#106">106</a>       <em class="jxr_comment">/*<em class="jxr_comment"> level &gt;= 1 */</em></em>
<a name="107" href="#107">107</a>       <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a>(uri().resolve(<span class="jxr_string">"./"</span>), <strong class="jxr_keyword">this</strong>.level - 1);
<a name="108" href="#108">108</a>     }
<a name="109" href="#109">109</a>   }
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>   <em class="jxr_javadoccomment">/**</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">   * Determine the number of times {@link #parent()} can be called without</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">   * returning a {@code null} value. The return value is always a non-negative</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">   * number.</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">   * </em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">   * @return number of parents</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">   */</em>
<a name="118" href="#118">118</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> level() {
<a name="119" href="#119">119</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.level;
<a name="120" href="#120">120</a>   }
<a name="121" href="#121">121</a> 
<a name="122" href="#122">122</a>   <em class="jxr_javadoccomment">/**</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">   * Compare two {@link ResourceKey} objects for equality. They are equal if</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment">   * their URIs are {@link java.net.URI#equals(Object) equal}.</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">   * </em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">   * @return boolean {@code true} if both key URIs match, {@code false}</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">   *         otherwise</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">   */</em>
<a name="129" href="#129">129</a>   @Override
<a name="130" href="#130">130</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(<strong class="jxr_keyword">final</strong> Object object) {
<a name="131" href="#131">131</a>     <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong> == object) {
<a name="132" href="#132">132</a>       <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="133" href="#133">133</a>     } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (object instanceof ResourceKey) {
<a name="134" href="#134">134</a>       <strong class="jxr_keyword">final</strong> <a href="../../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a> other = (ResourceKey) (object);
<a name="135" href="#135">135</a> 
<a name="136" href="#136">136</a>       <em class="jxr_comment">/*<em class="jxr_comment"> other is not null */</em></em>
<a name="137" href="#137">137</a>       <strong class="jxr_keyword">return</strong> uri().equals(other.uri());
<a name="138" href="#138">138</a>     } <strong class="jxr_keyword">else</strong> {
<a name="139" href="#139">139</a>       <strong class="jxr_keyword">return</strong> false;
<a name="140" href="#140">140</a>     }
<a name="141" href="#141">141</a>   }
<a name="142" href="#142">142</a> 
<a name="143" href="#143">143</a>   <em class="jxr_javadoccomment">/**</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">   * Compute the hash code from resource URI.</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">   * </em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">   * @return hash code of this key</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">   */</em>
<a name="148" href="#148">148</a>   @Override
<a name="149" href="#149">149</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() {
<a name="150" href="#150">150</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.uri.hashCode();
<a name="151" href="#151">151</a>   }
<a name="152" href="#152">152</a> 
<a name="153" href="#153">153</a>   <em class="jxr_javadoccomment">/**</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">   * Obtain a debug-friendly representation of this {@link ResourceKey}.</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">   */</em>
<a name="156" href="#156">156</a>   @Override
<a name="157" href="#157">157</a>   <strong class="jxr_keyword">public</strong> String toString() {
<a name="158" href="#158">158</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.uri.toString();
<a name="159" href="#159">159</a>   }
<a name="160" href="#160">160</a> 
<a name="161" href="#161">161</a>   <em class="jxr_javadoccomment">/**</em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">   * Strictly internal API to count the number of non-trailing slashes in the</em>
<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">   * provided URI path segment.</em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">   * </em>
<a name="165" href="#165">165</a> <em class="jxr_javadoccomment">   * @param path non-{@code null} URI path segment</em>
<a name="166" href="#166">166</a> <em class="jxr_javadoccomment">   * @return number of non-trailing slashes in URI path</em>
<a name="167" href="#167">167</a> <em class="jxr_javadoccomment">   */</em>
<a name="168" href="#168">168</a>   <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> countSlashes(<strong class="jxr_keyword">final</strong> String path) {
<a name="169" href="#169">169</a>     <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] chars = path.toCharArray();
<a name="170" href="#170">170</a> 
<a name="171" href="#171">171</a>     <em class="jxr_comment">/*<em class="jxr_comment"> count all delimiting slashes expect the trailing slash (if any) */</em></em>
<a name="172" href="#172">172</a>     <strong class="jxr_keyword">int</strong> slashes = 0;
<a name="173" href="#173">173</a>     <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; chars.length - 1; i++) {
<a name="174" href="#174">174</a>       <strong class="jxr_keyword">if</strong> (chars[i] == '/') {
<a name="175" href="#175">175</a>         slashes++;
<a name="176" href="#176">176</a>       }
<a name="177" href="#177">177</a>     }
<a name="178" href="#178">178</a> 
<a name="179" href="#179">179</a>     <strong class="jxr_keyword">return</strong> slashes;
<a name="180" href="#180">180</a>   }
<a name="181" href="#181">181</a> 
<a name="182" href="#182">182</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

